Einhugur Word Component for Buoy

Document Class

Class that represents docx Word document.

This class can Create, Read, Write and Edit Word documents.

Container
   Document

class Document

Constructors

DocumentPrivate constructor.

Properties

CreatedDateCreation date of the document. (Meta data)
CreatorCreator of the document. (Meta data)
DefaultSectionReturns default section for the document. (Default page setup for the document)
DescriptionDocument description. (Meta data)
DocumentDefaultsGets the document defaults object.
ItemCount (Inherited) Number of items in the container.
KeywordsKeywords for the document. (Meta data)
LastModifiedByName of person to last modify the document. (Meta data)
ModifiedDateLast modification date of the document. (Meta data)
ParagraphCount (Inherited) Returns number of paragraphs in the container.
SubjectDocument subject. (Meta data)
TableCount (Inherited) Returns number of tables in the container.
TitleDocument title. (Meta data)

Methods

AddNewCharacterStyleAdds new character style to the document.
AddNewParagraphStyleAdds new paragraph style to the document.
AddNewTableStyleAdds new table style to the document.
AppendPageBreakAppends page break at back of the document.
AppendParagraph (Inherited) Appends paragraph at back of the container, creating one run for the string passed in with this method.
AppendSectionBreakAppends section break with a given rule.
AppendTable (Inherited) Appends table to the back of the container.
ApplyFieldDataApplies filed data document wide. This covers paragraphs, tables, nested tables, nested paragraphs.
CharacterStylesReturns array of all predefined CharacterStyles in the document.
shared CreateCreates new document at given location.
CreateListIndentCreates ListIndent object to be used with group of paragraphs.
FooterGets footer of requested type from the document, optionally creating new footer if footer with the requested type does not exist.
GetBookmarksGets all bookmarks in the document.
HeaderGets header of requested type from the document, optionally creating new header if header with the requested type does not exist.
Item (Inherited) Returns item at given index. (Paragraphs or tables)
shared OpenOpens word document.
Paragraph (Inherited) Gets paragraph at given index.
ParagraphStylesReturns array of all predefined ParagraphStyles in the document.
RemoveBookmarkRemoves bookmark from the document.
RemoveItem (Inherited) Removes item from the container.
SaveSaves the document.
SaveAsSaves the document with new name and or path.
shared SetLicenseSets license key for the component to take it out of demo mode.
Table (Inherited) Gets table at given index.
TableStylesReturns array of all predefined TableStyles in the document.

Supported Platforms:

  • macOS Intel 64 bit
  • macOS Apple Silicon
  • Windows 64 bit
  • Windows ARM 64 bit
  • Linux 64 bit
  • Linux ARM 64 bit